<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>リソースプラグイン</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
<link rel="home" href="index.html" title="Smarty マニュアル">
<link rel="up" href="plugins.html" title="Chapter 16. プラグインによる Smarty の拡張">
<link rel="prev" href="plugins.outputfilters.html" title="アウトプットフィルタプラグイン">
<link rel="next" href="plugins.inserts.html" title="インサートプラグイン">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr><th colspan="3" align="center">リソースプラグイン</th></tr>
<tr>
<td width="20%" align="left">
<a accesskey="p" href="plugins.outputfilters.html">Prev</a> </td>
<th width="60%" align="center">Chapter 16. プラグインによる Smarty の拡張</th>
<td width="20%" align="right"> <a accesskey="n" href="plugins.inserts.html">Next</a>
</td>
</tr>
</table>
<hr>
</div>
<div class="sect1" title="リソースプラグイン">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="plugins.resources"></a>リソースプラグイン</h2></div></div></div>
<p>
     リソースプラグインは、テンプレートソースやPHPスクリプトのコンポーネントを
     Smarty に提供する一般的な方法と意図されています
     （例： データベース, LDAP, 共有メモリ, ソケット等）。
    </p>
<p>
     各種リソースのために４つの関数を登録する必要があります。
     これらの関数の最初のパラメータには要求されたリソースが渡され、
     最後のパラメータには Smarty のオブジェクトが渡されます。
     残りのパラメータは関数によって異なります。
    </p>
<div class="funcsynopsis">
<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">bool <b class="fsfunc">smarty_resource_name_source</b>(</code></td>
<td>
<var class="pdparam">$rsrc_name</var>, </td>
<td> </td>
</tr>
<tr>
<td> </td>
<td>
<var class="pdparam">&amp;$source</var>, </td>
<td> </td>
</tr>
<tr>
<td> </td>
<td>
<var class="pdparam">&amp;$smarty</var><code>)</code>;</td>
<td> </td>
</tr>
</table>
<div class="paramdef-list">
<code>string <var class="pdparam">$rsrc_name</var></code>;<br><code>string <var class="pdparam">&amp;$source</var></code>;<br><code>object <var class="pdparam">&amp;$smarty</var></code>;</div>
<div class="funcprototype-spacer"> </div>
<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">bool <b class="fsfunc">smarty_resource_name_timestamp</b>(</code></td>
<td>
<var class="pdparam">$rsrc_name</var>, </td>
<td> </td>
</tr>
<tr>
<td> </td>
<td>
<var class="pdparam">&amp;$timestamp</var>, </td>
<td> </td>
</tr>
<tr>
<td> </td>
<td>
<var class="pdparam">&amp;$smarty</var><code>)</code>;</td>
<td> </td>
</tr>
</table>
<div class="paramdef-list">
<code>string <var class="pdparam">$rsrc_name</var></code>;<br><code>int <var class="pdparam">&amp;$timestamp</var></code>;<br><code>object <var class="pdparam">&amp;$smarty</var></code>;</div>
<div class="funcprototype-spacer"> </div>
<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">bool <b class="fsfunc">smarty_resource_name_secure</b>(</code></td>
<td>
<var class="pdparam">$rsrc_name</var>, </td>
<td> </td>
</tr>
<tr>
<td> </td>
<td>
<var class="pdparam">&amp;$smarty</var><code>)</code>;</td>
<td> </td>
</tr>
</table>
<div class="paramdef-list">
<code>string <var class="pdparam">$rsrc_name</var></code>;<br><code>object <var class="pdparam">&amp;$smarty</var></code>;</div>
<div class="funcprototype-spacer"> </div>
<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">bool <b class="fsfunc">smarty_resource_name_trusted</b>(</code></td>
<td>
<var class="pdparam">$rsrc_name</var>, </td>
<td> </td>
</tr>
<tr>
<td> </td>
<td>
<var class="pdparam">&amp;$smarty</var><code>)</code>;</td>
<td> </td>
</tr>
</table>
<div class="paramdef-list">
<code>string <var class="pdparam">$rsrc_name</var></code>;<br><code>object <var class="pdparam">&amp;$smarty</var></code>;</div>
<div class="funcprototype-spacer"> </div>
</div>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem"><p>
     １つめの関数 <code class="literal">source()</code> ではリソースを取得します。
     第２パラメータ <em class="parameter"><code>$source</code></em>
     は参照で渡され、ここに結果が格納されます。
     戻り値は、リソースの取得に成功すれば <code class="constant">TRUE</code>、
     それ以外は <code class="constant">FALSE</code> となります。
    </p></li>
<li class="listitem"><p>
     ２つめの関数 <code class="literal">timestamp()</code> は、
     要求されたリソースが最後に修正された時間(UNIXタイムスタンプ)を取得します。
     第２パラメータ <em class="parameter"><code>$timestamp</code></em> は参照で渡され、
     ここにタイムスタンプが格納されます。タイムスタンプが取得できれば
     <code class="constant">TRUE</code>、それ以外は <code class="constant">FALSE</code> を返します。
    </p></li>
<li class="listitem"><p>
     ３つめの関数 <code class="literal">secure()</code> は、
     要求されたリソースがセキュアであるかどうかに応じて <code class="constant">TRUE</code> 又は <code class="constant">FALSE</code> を返します。
     この関数はテンプレートリソースのためにだけ用いられますが、定義する必要があります。
    </p></li>
<li class="listitem"><p>
     ４つめの関数 <code class="literal">trusted()</code> は、
     要求されたリソースが信用できるかどうかに応じて <code class="constant">TRUE</code> 又は <code class="constant">FALSE</code> を返します。
     この関数を使用するのは、<a class="link" href="language.function.include.php.html" title="{include_php}">
     <code class="varname">{include_php}</code></a> タグあるいは
     <a class="link" href="language.function.insert.html" title="{insert}"><code class="varname">{insert}</code></a>
     タグで <em class="parameter"><code>src</code></em> 属性によって要求された PHP
     スクリプトコンポーネントのみです。
     しかし、テンプレートリソースであっても定義する必要があります。
    </p></li>
</ul></div>
<div class="example">
<a name="id2863312"></a><p class="title"><b>Example 16.10. リソースプラグイン</b></p>
<div class="example-contents"><pre class="programlisting">

&lt;?php
/*
 * Smarty plugin
 * -------------------------------------------------------------
 * File:     resource.db.php
 * Type:     resource
 * Name:     db
 * Purpose:  データベースからテンプレートを取得する
 * -------------------------------------------------------------
 */
function smarty_resource_db_source($tpl_name, &amp;$tpl_source, &amp;$smarty)
{
    // ここでデータベースを呼び出し、
    // 失際のテンプレートの内容を $tpl_source に代入します
    $tpl_source = "This is the template text";
    // 成功した場合に true を返します。false を返すと失敗したことになります
    return true;
}

function smarty_resource_db_timestamp($tpl_name, &amp;$tpl_timestamp, &amp;$smarty)
{
    // テンプレートの最終更新時刻の Unix タイムスタンプを
    // $tpl_timestampに代入するためにデータベースを呼び出します
    // これで、再コンパイルが必要かどうかを判断します
    $tpl_timestamp = time(); // この例だと常に再コンパイルとなります!
    // 成功した場合に true を返します。false を返すと失敗したことになります
    return true;
}

function smarty_resource_db_secure($tpl_name, &amp;$smarty)
{
    // 全てのテンプレートがセキュアであるとみなします
    return true;
}

function smarty_resource_db_trusted($tpl_name, &amp;$smarty)
{
    // テンプレートでは使用しません
}
?&gt;

     </pre></div>
</div>
<br class="example-break"><p>
 <a class="link" href="api.register.resource.html" title="register_resource()"><code class="varname">register_resource()</code></a>
 および
 <a class="link" href="api.unregister.resource.html" title="unregister_resource()"><code class="varname">unregister_resource()</code></a>
 も参照してください。
</p>
</div>
<div class="navfooter">
<hr>
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
<a accesskey="p" href="plugins.outputfilters.html">Prev</a> </td>
<td width="20%" align="center"><a accesskey="u" href="plugins.html">Up</a></td>
<td width="40%" align="right"> <a accesskey="n" href="plugins.inserts.html">Next</a>
</td>
</tr>
<tr>
<td width="40%" align="left" valign="top">アウトプットフィルタプラグイン </td>
<td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td>
<td width="40%" align="right" valign="top"> インサートプラグイン</td>
</tr>
</table>
</div>
</body>
</html>
